feat: add alternate domain names to cdn site host construct #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephenrob
approved these changes
Oct 26, 2023
There was a problem hiding this comment.
Do we need this test file in the example as its basically an empty file
There was a problem hiding this comment.
It's generated automatically as a place holder with the cdk init --language typescript.
It's sort of nice as a place holder - but I will delete it.
mrliptontea
reviewed
Oct 26, 2023
Comment on lines
49
to
50
| // aliases: [siteDomain], | ||
| aliases: aliases, |
There was a problem hiding this comment.
I think I'd be happier with this:
Suggested change
| // aliases: [siteDomain], | |
| aliases: aliases, | |
| aliases: [siteDomain, ...aliases], |
It makes it clear that the siteDomain is there and that it's the main one.
lib/cdn-site-hosting/utils.ts
Outdated
| const aliases = props.aliasSubDomains | ||
| ? props.aliasSubDomains.map((alias) => `${alias}.${props.domainName}`) | ||
| : []; | ||
| aliases.push(getSiteDomain(props)); |
There was a problem hiding this comment.
Like I commented above, I don't think siteDomain should be here.
mrliptontea
approved these changes
Oct 26, 2023
junglebarry
approved these changes
Oct 27, 2023
malcyL
changed the title
|
🎉 This PR is included in version 3.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
We have had outages to both smalti's internal UI and production elevate caused by the cloud front distribution deleting the alias for the live DNS name when a release is performed.
This is because we manually create the DNS entry and the cloud front distribution alias for it. We haven't included these in the cloud formation stack previously because we want to be able to follow a process of deploying a new stack alongside a live stack and switch to it when we are happy. We want to use DNS to do this in the same way we would when bringing up a new instance of a traditional web server.
If the DNS entry or the cloud front distribution alias are contained in the cloud formation stack, a new stack with a different watermark can not be created alongside the live production stack. The DNS entry and the cloud front distribution alias can not be duplicated in another stack - the stack creation fails.
Possible Solutions Discussed To Resolve This
These options are from this investigation ticket: https://github.com/talis/platform/issues/6436#issuecomment-1505271353
Option 1 - Pro - minimal change to code. Con - Potential short downtime on every release.
Option 2 - Pro - minimal change to code. Con - increase in complexity around deployments in hercules and individual projects
Option 3 - Pro - Deployment moved away from making any changes to Cloud Front. Con - this is a much bigger change
The decision was to go for Option 2. This PR implements that solution.
Changes in This PR
Changes to the construct:
aliasSubDomainsaliasSubDomainsare added as aliases to the cloud front distributionA simple cdn site hosting construct example has been added to the examples section. This example:
The integration tests have been extended to run against this new sample project in the same way we have integration tests running against the other samples
The circle build has therefore been updated to deploy the new sample in parallel to it's deployments of the other samples.
The PR also adds a
Best Practicessection into the README to describe the imagined process for resolving this issue - changes are needed in both hercules and consuming projects.Smoke Testing
We have tested running through the envisaged process of bringing up a new stack and making it live alongside an existing live stack.
I was concerned about the final step - cloud formation adding in the new alias which has actually been added manually at the time of the DNS change.
However, this step did work and there are no issues with future releases after the switch.
Details here: https://techfromsage.atlassian.net/browse/PLT-62?focusedCommentId=110708